.TH lha_form 1 "01 May 2012" "TrueCL Commands"

.SH NAME
lha_dissolve \- Stop a Running Cluster

.SH SYNOPSES
.TS
l l.
lha_dissolve	[\fB--kill\fP \fIdaemon\fP|\fIALL\fP] [\fB--restart\fP \fIdaemon\fP|\fIALL\fP] [\fB--force\fP]
	[\fB-timeout\fP \fIN\fP] [\fB--abort\fP] [\fB--debug\fP|\fB--verbose\fP|\fB--quiet\fP|\fB--silent\fP]
	[\fB--lwidth\fP \fIN\fP]
.TE

.SH DESCRIPTION
The \fIlha_dissolve(1)\fP command is used to stop a currently running cluster. It can
be initiated on any node that is configured as part of the cluster - even if that node
itself is not currently part of the formed cluster. 

However the utility is also a bit more flexible than that; it can be used as a utility
to start or restart particular daemons too; useful if they have been replaced or 
modified as part of an online software upgrade.

.SH ARGUMENTS
.TP 8
--kill
All instances of the specified daemon are killed off on the nodes that currently form
part of the running cluster. The daemon can be either 'netd', 'nbh', 'lockd', 'syncd',
\'statd' or 'mond'. \fBStopping the cluster daemon using this tool is not supported.\fP

When this argument is used the cluster is left running [apart from the specified daemon], 
and so application availability is unaffected. Of course if a problem occurs then action
might not be taken if daemon responsible for handling this situation is no longer running.

Optionally the word 'ALL' may be given to stop all daemons apart from the main cluster daemon.
.TP
--restart
This is similar to the \fI--kill\fP option - though rather than just stopping the specified
daemon it is stopped and then immediately restarted. This functionality is probably the 
most appropriate if you simply wish to 'refresh' a running daemon for whatever purpose. 

The list of daemons that can be restarted is identical to the \fI--kill\fP option, and again
the 'ALL' value can be specified to restart all supported daemons across all nodes in the
currently formed cluster.
.TP
--force
The default functionality of the \fIlha_dissolve(1)\fP command is to abort with an error
message if any applications are currently running and an attempt is made to stop the
cluster. Specification of this argument will result in those applications being shutdown,
and once shutdown the cluster will then be halted.
.TP
--abort
This stops all cluster daemons - even if applications are currently running. Those 
applications will remain available, though of course, no actions will be taken when
failures occur. At any point the \fIlha_form(1)\fP command can be used to restart the
cluster - and in almost all cases it will find out which applications are currently running
and configure itself appropriately.
.TP
--timeout
The amount of time to wait for a node to respond to a request to
indicate whether it is alive or not. Defaults to 3 seconds if not
specified.
.TP
--debug
Run the tool in debug more - might produce significant amounts of output
to the standard output and standard error devices.
.TP
--verbose
Verbose mode generates a sensible amount of output to standard output to 
show the progress of cluster shutdown. This is the recommended flag if
the administrator wishes to see any output.
.TP
--quiet
This will only produce errors and warnings on the standard output device.
.TP
--silent
Only produce output if fatal errors occurs during cluster shutdown.
.TP
--lwidth
Specifies the width of any output logged to the standard output device. If not
specified it defaults to the width of the current terminal if it can be defined,
otherwise it will default to 80.

.SH OUTPUT
The output generated by the tool will go the standard output device. It is
usual to see only a few lines, though if applications are being shutdown 
the output will be more verbose [when running with the suitable level of
verbosity specified].

.SH EXIT CODES
If the cluster stops as expected a value of 0 will be returned, otherwise 1
will indicate an error. If an error occurs the cluster might be running or
might have aborted in a partially shutdown state. In all cases use the \fIlha_stat(1)\fP
command to view the current cluster state and take the appropriate action.

.SH FILES
Not applicable for the command/utility.

.SH NOTES
The \fIclreq(1)\fP command can be used to perform many of the actions this utility
provides. However the recommended approach is to use this tool whenever possible
since it performs a series of safe-guard checks - something the available \fIclreq(1)\fP
commands do not do.

.SH AUTHOR
The TrueCL software was written by Simon Edwards, (C) 2006-2009, working
for Advantsys Computer Services Ltd - www.advantsys.co.uk.

.SH SEE ALSO
.BR lha_form(1),
.BR lha_stopnode(1)

.SH AVAILABILITY
This utility was specifically written under the GNU GPL license and as required
by such software comes with \fIno warranty or guarantee of any kind\fP. For
more information, please see the following page: truecl.advantsys.co.uk.

